<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.codemonkey.swiftsocketserver;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.io.BufferedReader;<a name="line.3"></a>
<FONT color="green">004</FONT>    import java.io.IOException;<a name="line.4"></a>
<FONT color="green">005</FONT>    import java.lang.reflect.InvocationTargetException;<a name="line.5"></a>
<FONT color="green">006</FONT>    import java.net.Socket;<a name="line.6"></a>
<FONT color="green">007</FONT>    import java.net.SocketException;<a name="line.7"></a>
<FONT color="green">008</FONT>    import java.util.Date;<a name="line.8"></a>
<FONT color="green">009</FONT>    <a name="line.9"></a>
<FONT color="green">010</FONT>    import org.apache.commons.lang.StringUtils;<a name="line.10"></a>
<FONT color="green">011</FONT>    import org.apache.log4j.Logger;<a name="line.11"></a>
<FONT color="green">012</FONT>    <a name="line.12"></a>
<FONT color="green">013</FONT>    /**<a name="line.13"></a>
<FONT color="green">014</FONT>     * Worker thread for the server that is dedicated to a single client.<a name="line.14"></a>
<FONT color="green">015</FONT>     * &lt;p&gt;<a name="line.15"></a>
<FONT color="green">016</FONT>     * Sets up a child thread that listens for client input, while pinging the client to test connection. Since Java cannot detect if a client<a name="line.16"></a>
<FONT color="green">017</FONT>     * closes the TCP connection, we manually test the connection by pinging the client. If the client does not respond with<a name="line.17"></a>
<FONT color="green">018</FONT>     * {@link #pingPongTimeoutMs}, the server assumes the connection went dead.<a name="line.18"></a>
<FONT color="green">019</FONT>     * <a name="line.19"></a>
<FONT color="green">020</FONT>     * @author Benny Bottema<a name="line.20"></a>
<FONT color="green">021</FONT>     * @see InputHandler<a name="line.21"></a>
<FONT color="green">022</FONT>     * @see SwiftSocketServer<a name="line.22"></a>
<FONT color="green">023</FONT>     * @see #checkPing()<a name="line.23"></a>
<FONT color="green">024</FONT>     * @see #checkPong()<a name="line.24"></a>
<FONT color="green">025</FONT>     * @since 1.0<a name="line.25"></a>
<FONT color="green">026</FONT>     */<a name="line.26"></a>
<FONT color="green">027</FONT>    public class ClientHandler implements Runnable {<a name="line.27"></a>
<FONT color="green">028</FONT>    <a name="line.28"></a>
<FONT color="green">029</FONT>            /**<a name="line.29"></a>
<FONT color="green">030</FONT>             * The length of the message id of a message string (binary packet).<a name="line.30"></a>
<FONT color="green">031</FONT>             */<a name="line.31"></a>
<FONT color="green">032</FONT>            protected static final int MESSAGEID_LENGTH = 3;<a name="line.32"></a>
<FONT color="green">033</FONT>    <a name="line.33"></a>
<FONT color="green">034</FONT>            /**<a name="line.34"></a>
<FONT color="green">035</FONT>             * Interval in milliseconds for ping messages to the client.<a name="line.35"></a>
<FONT color="green">036</FONT>             * <a name="line.36"></a>
<FONT color="green">037</FONT>             * @see #checkPing()<a name="line.37"></a>
<FONT color="green">038</FONT>             * @see #checkPong()<a name="line.38"></a>
<FONT color="green">039</FONT>             */<a name="line.39"></a>
<FONT color="green">040</FONT>            private int pingPongIntervalMs;<a name="line.40"></a>
<FONT color="green">041</FONT>    <a name="line.41"></a>
<FONT color="green">042</FONT>            /**<a name="line.42"></a>
<FONT color="green">043</FONT>             * Timeout in milliseconds for a pong message to the client.<a name="line.43"></a>
<FONT color="green">044</FONT>             * <a name="line.44"></a>
<FONT color="green">045</FONT>             * @see #checkPing()<a name="line.45"></a>
<FONT color="green">046</FONT>             * @see #checkPong()<a name="line.46"></a>
<FONT color="green">047</FONT>             */<a name="line.47"></a>
<FONT color="green">048</FONT>            private int pingPongTimeoutMs = 5000;<a name="line.48"></a>
<FONT color="green">049</FONT>    <a name="line.49"></a>
<FONT color="green">050</FONT>            /**<a name="line.50"></a>
<FONT color="green">051</FONT>             * Basic logger to log events such as client timeouts and other client related events.<a name="line.51"></a>
<FONT color="green">052</FONT>             */<a name="line.52"></a>
<FONT color="green">053</FONT>            private static final Logger LOGGER = Logger.getLogger(ClientHandler.class);<a name="line.53"></a>
<FONT color="green">054</FONT>    <a name="line.54"></a>
<FONT color="green">055</FONT>            /**<a name="line.55"></a>
<FONT color="green">056</FONT>             * The {@link SwiftSocketServer} instance used to check server status and acquire {@link ClientMessageToServer} messages from.<a name="line.56"></a>
<FONT color="green">057</FONT>             */<a name="line.57"></a>
<FONT color="green">058</FONT>            private final SwiftSocketServer server;<a name="line.58"></a>
<FONT color="green">059</FONT>    <a name="line.59"></a>
<FONT color="green">060</FONT>            /**<a name="line.60"></a>
<FONT color="green">061</FONT>             * The {@link ClientContext} containing all session data concerning the client. Also contains a session data container for external use<a name="line.61"></a>
<FONT color="green">062</FONT>             * only. External users can utilize this container to store client related data for the duration of the connection.<a name="line.62"></a>
<FONT color="green">063</FONT>             */<a name="line.63"></a>
<FONT color="green">064</FONT>            private final ClientContext clientContext;<a name="line.64"></a>
<FONT color="green">065</FONT>    <a name="line.65"></a>
<FONT color="green">066</FONT>            private final boolean pingPongMode;<a name="line.66"></a>
<FONT color="green">067</FONT>    <a name="line.67"></a>
<FONT color="green">068</FONT>            /**<a name="line.68"></a>
<FONT color="green">069</FONT>             * Constructor, which accepts a {@link SwiftSocketServer} instance and a client {@link ClientContext}. Also resets<a name="line.69"></a>
<FONT color="green">070</FONT>             * {@link ClientContext#getPingtime()} and {@link ClientContext#isPongReceived()} flags.<a name="line.70"></a>
<FONT color="green">071</FONT>             * <a name="line.71"></a>
<FONT color="green">072</FONT>             * @param server Server used to check on the server status (ie. server is stopping).<a name="line.72"></a>
<FONT color="green">073</FONT>             * @param pingPongMode Indicates whether to perform PingPong polling to the client to detect drop outs.<a name="line.73"></a>
<FONT color="green">074</FONT>             * @param clientContext The context containing the client socket to which this worker thread is dedicated to.<a name="line.74"></a>
<FONT color="green">075</FONT>             * @param pingPongIntervalMs The Ping Pong interval used if {@link #pingPongMode} is turned on.<a name="line.75"></a>
<FONT color="green">076</FONT>             * @param pingPongTimeoutMs The Ping Pong timeout used if {@link #pingPongMode} is turned on.<a name="line.76"></a>
<FONT color="green">077</FONT>             */<a name="line.77"></a>
<FONT color="green">078</FONT>            protected ClientHandler(final SwiftSocketServer server, final ClientContext clientContext, final boolean pingPongMode,<a name="line.78"></a>
<FONT color="green">079</FONT>                            int pingPongIntervalMs, int pingPongTimeoutMs) {<a name="line.79"></a>
<FONT color="green">080</FONT>                    this.server = server;<a name="line.80"></a>
<FONT color="green">081</FONT>                    this.clientContext = clientContext;<a name="line.81"></a>
<FONT color="green">082</FONT>                    this.pingPongMode = pingPongMode;<a name="line.82"></a>
<FONT color="green">083</FONT>                    this.pingPongIntervalMs = pingPongIntervalMs;<a name="line.83"></a>
<FONT color="green">084</FONT>                    this.pingPongTimeoutMs = pingPongTimeoutMs;<a name="line.84"></a>
<FONT color="green">085</FONT>            }<a name="line.85"></a>
<FONT color="green">086</FONT>    <a name="line.86"></a>
<FONT color="green">087</FONT>            /**<a name="line.87"></a>
<FONT color="green">088</FONT>             * Thread method that runs ping messages to the client and tests for timeouts. Also sets up client thread that waits for input; a new<a name="line.88"></a>
<FONT color="green">089</FONT>             * thread is used since this action is blocking and the thread 'sleeps' until input is available, which would deny us the opportunity to<a name="line.89"></a>
<FONT color="green">090</FONT>             * do ping messages.&lt;br /&gt;<a name="line.90"></a>
<FONT color="green">091</FONT>             * &lt;br /&gt;<a name="line.91"></a>
<FONT color="green">092</FONT>             * Keeps pinging the client while the server is running.<a name="line.92"></a>
<FONT color="green">093</FONT>             * <a name="line.93"></a>
<FONT color="green">094</FONT>             * @see java.lang.Runnable#run()<a name="line.94"></a>
<FONT color="green">095</FONT>             * @see #checkPing()<a name="line.95"></a>
<FONT color="green">096</FONT>             * @see #checkPong()<a name="line.96"></a>
<FONT color="green">097</FONT>             * @see SwiftSocketServer#isRunning()<a name="line.97"></a>
<FONT color="green">098</FONT>             */<a name="line.98"></a>
<FONT color="green">099</FONT>            @Override<a name="line.99"></a>
<FONT color="green">100</FONT>            public final void run() {<a name="line.100"></a>
<FONT color="green">101</FONT>                    final Thread inputThread = new Thread(new InputHandler());<a name="line.101"></a>
<FONT color="green">102</FONT>                    inputThread.start();<a name="line.102"></a>
<FONT color="green">103</FONT>    <a name="line.103"></a>
<FONT color="green">104</FONT>                    if (pingPongMode) {<a name="line.104"></a>
<FONT color="green">105</FONT>                            ping();<a name="line.105"></a>
<FONT color="green">106</FONT>                    }<a name="line.106"></a>
<FONT color="green">107</FONT>                    while (server.isRunning()) {<a name="line.107"></a>
<FONT color="green">108</FONT>                            if (!clientContext.isClientSaidByeBye()) {<a name="line.108"></a>
<FONT color="green">109</FONT>                                    if (pingPongMode) {<a name="line.109"></a>
<FONT color="green">110</FONT>                                            if (checkPong()) {<a name="line.110"></a>
<FONT color="green">111</FONT>                                                    checkPing();<a name="line.111"></a>
<FONT color="green">112</FONT>                                            } else {<a name="line.112"></a>
<FONT color="green">113</FONT>                                                    LOGGER.debug(String.format("dropping client %s, reason: timeout", clientContext));<a name="line.113"></a>
<FONT color="green">114</FONT>                                                    server.disposeOfClient(clientContext);<a name="line.114"></a>
<FONT color="green">115</FONT>                                                    break;<a name="line.115"></a>
<FONT color="green">116</FONT>                                            }<a name="line.116"></a>
<FONT color="green">117</FONT>                                    } else {<a name="line.117"></a>
<FONT color="green">118</FONT>                                            // PingPong mode is turned off, we won't be dropping clients due to time-outs<a name="line.118"></a>
<FONT color="green">119</FONT>                                    }<a name="line.119"></a>
<FONT color="green">120</FONT>                                    ServerUtil.defaultSleep(); // avoid hogging cpu<a name="line.120"></a>
<FONT color="green">121</FONT>                            } else {<a name="line.121"></a>
<FONT color="green">122</FONT>                                    LOGGER.debug(String.format("dropping client %s, reason: client went away", clientContext.getClientInetAddress()));<a name="line.122"></a>
<FONT color="green">123</FONT>                                    break;<a name="line.123"></a>
<FONT color="green">124</FONT>                            }<a name="line.124"></a>
<FONT color="green">125</FONT>                    }<a name="line.125"></a>
<FONT color="green">126</FONT>            }<a name="line.126"></a>
<FONT color="green">127</FONT>    <a name="line.127"></a>
<FONT color="green">128</FONT>            /**<a name="line.128"></a>
<FONT color="green">129</FONT>             * Sends a ping message to the client, which on turn should respond with a 'pong' notification. A ping is sent only if the following<a name="line.129"></a>
<FONT color="green">130</FONT>             * requirements are met:<a name="line.130"></a>
<FONT color="green">131</FONT>             * &lt;ol&gt;<a name="line.131"></a>
<FONT color="green">132</FONT>             * &lt;li&gt;A pong response has been received; we don't want to send out multiple ping messages&lt;/li&gt;<a name="line.132"></a>
<FONT color="green">133</FONT>             * &lt;li&gt;The last ping message time stamp exceeds {@link #PING_INTERVAL}&lt;/li&gt;<a name="line.133"></a>
<FONT color="green">134</FONT>             * &lt;/ol&gt;<a name="line.134"></a>
<FONT color="green">135</FONT>             * <a name="line.135"></a>
<FONT color="green">136</FONT>             * @see #ping()<a name="line.136"></a>
<FONT color="green">137</FONT>             * @see #pong()<a name="line.137"></a>
<FONT color="green">138</FONT>             * @see ClientContext#getPingtime()<a name="line.138"></a>
<FONT color="green">139</FONT>             * @see ClientContext#isPongReceived()<a name="line.139"></a>
<FONT color="green">140</FONT>             * @see #PINGPONG_TIMEOUT<a name="line.140"></a>
<FONT color="green">141</FONT>             * @see #PING_INTERVAL<a name="line.141"></a>
<FONT color="green">142</FONT>             * @see #checkPong()<a name="line.142"></a>
<FONT color="green">143</FONT>             */<a name="line.143"></a>
<FONT color="green">144</FONT>            private void checkPing() {<a name="line.144"></a>
<FONT color="green">145</FONT>                    final long pongDelay = new Date().getTime() - clientContext.getPingtime();<a name="line.145"></a>
<FONT color="green">146</FONT>                    if (clientContext.isPongReceived() &amp;&amp; pongDelay &gt; pingPongIntervalMs) {<a name="line.146"></a>
<FONT color="green">147</FONT>                            ping();<a name="line.147"></a>
<FONT color="green">148</FONT>                    }<a name="line.148"></a>
<FONT color="green">149</FONT>            }<a name="line.149"></a>
<FONT color="green">150</FONT>    <a name="line.150"></a>
<FONT color="green">151</FONT>            /**<a name="line.151"></a>
<FONT color="green">152</FONT>             * Evaluates whether the client has sent the last pong message, or else if the client has still time to respond with a pong<a name="line.152"></a>
<FONT color="green">153</FONT>             * notification. In other words: "returns that the client hasn't timed out yet".<a name="line.153"></a>
<FONT color="green">154</FONT>             * <a name="line.154"></a>
<FONT color="green">155</FONT>             * @return Whether pong hasn't timed out yet.<a name="line.155"></a>
<FONT color="green">156</FONT>             * @see #ping()<a name="line.156"></a>
<FONT color="green">157</FONT>             * @see #pong()<a name="line.157"></a>
<FONT color="green">158</FONT>             * @see ClientContext#getPingtime()<a name="line.158"></a>
<FONT color="green">159</FONT>             * @see ClientContext#isPongReceived()<a name="line.159"></a>
<FONT color="green">160</FONT>             * @see #PINGPONG_TIMEOUT<a name="line.160"></a>
<FONT color="green">161</FONT>             * @see #PING_INTERVAL<a name="line.161"></a>
<FONT color="green">162</FONT>             * @see #checkPing()<a name="line.162"></a>
<FONT color="green">163</FONT>             */<a name="line.163"></a>
<FONT color="green">164</FONT>            private boolean checkPong() {<a name="line.164"></a>
<FONT color="green">165</FONT>                    return clientContext.isPongReceived() || new Date().getTime() - clientContext.getPingtime() &lt; pingPongTimeoutMs;<a name="line.165"></a>
<FONT color="green">166</FONT>            }<a name="line.166"></a>
<FONT color="green">167</FONT>    <a name="line.167"></a>
<FONT color="green">168</FONT>            /**<a name="line.168"></a>
<FONT color="green">169</FONT>             * Performs a ping message to the client, by using a {@link ServerMessageToClientPingPong}. Resets the response flags so we can keep<a name="line.169"></a>
<FONT color="green">170</FONT>             * track of the time between the ping message and the pong notification.<a name="line.170"></a>
<FONT color="green">171</FONT>             * <a name="line.171"></a>
<FONT color="green">172</FONT>             * @see ClientContext#getPingtime()<a name="line.172"></a>
<FONT color="green">173</FONT>             * @see ClientContext#isPongReceived()<a name="line.173"></a>
<FONT color="green">174</FONT>             */<a name="line.174"></a>
<FONT color="green">175</FONT>            private void ping() {<a name="line.175"></a>
<FONT color="green">176</FONT>                    sendMessage(new ServerMessageToClientPingPong(null));<a name="line.176"></a>
<FONT color="green">177</FONT>                    // reset pong response flags<a name="line.177"></a>
<FONT color="green">178</FONT>                    clientContext.setPingtime(new Date().getTime());<a name="line.178"></a>
<FONT color="green">179</FONT>                    clientContext.setPongReceived(false);<a name="line.179"></a>
<FONT color="green">180</FONT>    <a name="line.180"></a>
<FONT color="green">181</FONT>            }<a name="line.181"></a>
<FONT color="green">182</FONT>    <a name="line.182"></a>
<FONT color="green">183</FONT>            /**<a name="line.183"></a>
<FONT color="green">184</FONT>             * Invoked by {@link ClientMessageToServerPingPong#execute(ClientHandler)}, when the client is responding with a &lt;em&gt;pong&lt;/em&gt;<a name="line.184"></a>
<FONT color="green">185</FONT>             * notification. Sets {@link ClientContext#setPongReceived(boolean)} to &lt;code&gt;true&lt;/code&gt;, which is used to determine &lt;em&gt;ping&lt;/em&gt;<a name="line.185"></a>
<FONT color="green">186</FONT>             * timeout with.<a name="line.186"></a>
<FONT color="green">187</FONT>             * <a name="line.187"></a>
<FONT color="green">188</FONT>             * @see ClientContext#setPongReceived(boolean)<a name="line.188"></a>
<FONT color="green">189</FONT>             * @see #checkPong()<a name="line.189"></a>
<FONT color="green">190</FONT>             * @see ClientMessageToServerPingPong<a name="line.190"></a>
<FONT color="green">191</FONT>             */<a name="line.191"></a>
<FONT color="green">192</FONT>            public final void pong() {<a name="line.192"></a>
<FONT color="green">193</FONT>                    clientContext.setPongReceived(true);<a name="line.193"></a>
<FONT color="green">194</FONT>            }<a name="line.194"></a>
<FONT color="green">195</FONT>    <a name="line.195"></a>
<FONT color="green">196</FONT>            /**<a name="line.196"></a>
<FONT color="green">197</FONT>             * Called by {@link ClientMessageToServerByeBye#execute(ClientHandler)}. Set the 'Bye Bye' lag on the {@link #clientContext} and calls<a name="line.197"></a>
<FONT color="green">198</FONT>             * {@link ClientEndpoint#close()}.<a name="line.198"></a>
<FONT color="green">199</FONT>             */<a name="line.199"></a>
<FONT color="green">200</FONT>            protected void clientSaysByeBye() {<a name="line.200"></a>
<FONT color="green">201</FONT>                    server.disposeOfClient(clientContext);<a name="line.201"></a>
<FONT color="green">202</FONT>                    try {<a name="line.202"></a>
<FONT color="green">203</FONT>                            clientContext.getClientEndpoint().close();<a name="line.203"></a>
<FONT color="green">204</FONT>                    } catch (final IOException e) {<a name="line.204"></a>
<FONT color="green">205</FONT>                            throw new RuntimeException("error closing socket (already closed?)", e);<a name="line.205"></a>
<FONT color="green">206</FONT>                    }<a name="line.206"></a>
<FONT color="green">207</FONT>            }<a name="line.207"></a>
<FONT color="green">208</FONT>    <a name="line.208"></a>
<FONT color="green">209</FONT>            /**<a name="line.209"></a>
<FONT color="green">210</FONT>             * Logs and sends a response message to the current client using {@link #clientContext}, delegating the actual sending to<a name="line.210"></a>
<FONT color="green">211</FONT>             * {@link #sendMessage(ClientContext, int, ServerMessageToClient)}, unless the client has said 'Bye Bye' in which case the message to be<a name="line.211"></a>
<FONT color="green">212</FONT>             * sent is ignored altogether.<a name="line.212"></a>
<FONT color="green">213</FONT>             * <a name="line.213"></a>
<FONT color="green">214</FONT>             * @param message The server message to send to the client.<a name="line.214"></a>
<FONT color="green">215</FONT>             * @see ClientContext#isClientSaidByeBye()<a name="line.215"></a>
<FONT color="green">216</FONT>             * @see #sendMessage(ClientContext, int, ServerMessageToClient)<a name="line.216"></a>
<FONT color="green">217</FONT>             */<a name="line.217"></a>
<FONT color="green">218</FONT>            public void sendMessage(final ServerMessageToClient message) {<a name="line.218"></a>
<FONT color="green">219</FONT>                    final Logger messageLogger = determineLogger(message);<a name="line.219"></a>
<FONT color="green">220</FONT>                    messageLogger.debug(String.format("sending message to %s: %s", clientContext.getClientInetAddress(), message.getClass()<a name="line.220"></a>
<FONT color="green">221</FONT>                                    .getSimpleName()));<a name="line.221"></a>
<FONT color="green">222</FONT>                    if (!clientContext.isClientSaidByeBye()) {<a name="line.222"></a>
<FONT color="green">223</FONT>                            final int messageId = server.getServerMessageId(message.getClass());<a name="line.223"></a>
<FONT color="green">224</FONT>                            sendMessage(clientContext, messageId, message);<a name="line.224"></a>
<FONT color="green">225</FONT>                    } else {<a name="line.225"></a>
<FONT color="green">226</FONT>                            // log message, giving class logger priority<a name="line.226"></a>
<FONT color="green">227</FONT>                            Logger availableLogger = LOGGER;<a name="line.227"></a>
<FONT color="green">228</FONT>                            if (!LOGGER.isDebugEnabled() &amp;&amp; messageLogger.isDebugEnabled()) {<a name="line.228"></a>
<FONT color="green">229</FONT>                                    availableLogger = messageLogger;<a name="line.229"></a>
<FONT color="green">230</FONT>                            }<a name="line.230"></a>
<FONT color="green">231</FONT>                            availableLogger.debug(String.format("dropping message %s, reason: client already said byebye", message));<a name="line.231"></a>
<FONT color="green">232</FONT>                    }<a name="line.232"></a>
<FONT color="green">233</FONT>            }<a name="line.233"></a>
<FONT color="green">234</FONT>    <a name="line.234"></a>
<FONT color="green">235</FONT>            /**<a name="line.235"></a>
<FONT color="green">236</FONT>             * Helper method used to send a message to the client.<a name="line.236"></a>
<FONT color="green">237</FONT>             * <a name="line.237"></a>
<FONT color="green">238</FONT>             * @param clientContext The client to send the message to.<a name="line.238"></a>
<FONT color="green">239</FONT>             * @param messageId The message id, known to both the server and the client.<a name="line.239"></a>
<FONT color="green">240</FONT>             * @param message The {@link ClientMessageToServer} used to physically encode the message as &lt;code&gt;String&lt;/code&gt;.<a name="line.240"></a>
<FONT color="green">241</FONT>             */<a name="line.241"></a>
<FONT color="green">242</FONT>            private void sendMessage(final ClientContext clientContext, final int messageId, final ServerMessageToClient message) {<a name="line.242"></a>
<FONT color="green">243</FONT>                    final String paddedMessageId = StringUtils.leftPad(String.valueOf(messageId), MESSAGEID_LENGTH, '0');<a name="line.243"></a>
<FONT color="green">244</FONT>                    final String datagram = String.format("%s%s\n\0", paddedMessageId, message.encode());<a name="line.244"></a>
<FONT color="green">245</FONT>                    try {<a name="line.245"></a>
<FONT color="green">246</FONT>                            clientContext.getClientEndpoint().send(datagram);<a name="line.246"></a>
<FONT color="green">247</FONT>                    } catch (final IOException e) {<a name="line.247"></a>
<FONT color="green">248</FONT>                            throw new RuntimeException(String.format("unable to send message to client %s", clientContext.getClientInetAddress()), e);<a name="line.248"></a>
<FONT color="green">249</FONT>                    }<a name="line.249"></a>
<FONT color="green">250</FONT>            }<a name="line.250"></a>
<FONT color="green">251</FONT>    <a name="line.251"></a>
<FONT color="green">252</FONT>            /**<a name="line.252"></a>
<FONT color="green">253</FONT>             * Returns the class logger {@link #LOGGER} in case of user defined message types, or a message type specific logger if it is a native<a name="line.253"></a>
<FONT color="green">254</FONT>             * message type. This is so that we're able to differentiate log levels between Ping Pong messages (to mute them effectively) and other<a name="line.254"></a>
<FONT color="green">255</FONT>             * messages we'd still like to see in out logging.<a name="line.255"></a>
<FONT color="green">256</FONT>             * <a name="line.256"></a>
<FONT color="green">257</FONT>             * @param object The object doing the logging.<a name="line.257"></a>
<FONT color="green">258</FONT>             * @return The correct logger to avoid using log4j on end user classes (who may not support log4j and get due warnings) and still be<a name="line.258"></a>
<FONT color="green">259</FONT>             *         able to mute specific native message types, such as {@link ClientMessageToServerPingPong}.<a name="line.259"></a>
<FONT color="green">260</FONT>             */<a name="line.260"></a>
<FONT color="green">261</FONT>            private Logger determineLogger(final Object object) {<a name="line.261"></a>
<FONT color="green">262</FONT>                    if (object.getClass().getPackage() == ClientHandler.class.getPackage()) {<a name="line.262"></a>
<FONT color="green">263</FONT>                            return Logger.getLogger(object.getClass());<a name="line.263"></a>
<FONT color="green">264</FONT>                    } else {<a name="line.264"></a>
<FONT color="green">265</FONT>                            return LOGGER;<a name="line.265"></a>
<FONT color="green">266</FONT>                    }<a name="line.266"></a>
<FONT color="green">267</FONT>            }<a name="line.267"></a>
<FONT color="green">268</FONT>    <a name="line.268"></a>
<FONT color="green">269</FONT>            /**<a name="line.269"></a>
<FONT color="green">270</FONT>             * @return The {@link #clientContext} containing session data for external use.<a name="line.270"></a>
<FONT color="green">271</FONT>             */<a name="line.271"></a>
<FONT color="green">272</FONT>            public ClientContext getClientContext() {<a name="line.272"></a>
<FONT color="green">273</FONT>                    return clientContext;<a name="line.273"></a>
<FONT color="green">274</FONT>            }<a name="line.274"></a>
<FONT color="green">275</FONT>    <a name="line.275"></a>
<FONT color="green">276</FONT>            /**<a name="line.276"></a>
<FONT color="green">277</FONT>             * Listens to client and converts input to objects of type {@link ClientMessageToServer}. A thread is being used for this, since reading<a name="line.277"></a>
<FONT color="green">278</FONT>             * input is blocking, meaning the thread 'sleeps' while waiting for input. These messages are then added to the client messages queue<a name="line.278"></a>
<FONT color="green">279</FONT>             * for execution by external user.&lt;br /&gt;<a name="line.279"></a>
<FONT color="green">280</FONT>             * &lt;strong&gt;Note:&lt;/strong&gt; some messages are filtered by the server as they are of server level, such as pong messages.&lt;br /&gt;<a name="line.280"></a>
<FONT color="green">281</FONT>             * &lt;br /&gt;<a name="line.281"></a>
<FONT color="green">282</FONT>             * Reuses fields from {@link ClientHandler}, such as {@link ClientHandler#clientContext} and {@link ClientHandler#server}. Keeps<a name="line.282"></a>
<FONT color="green">283</FONT>             * listening for input while the server is still running and the client hasn't timed out.<a name="line.283"></a>
<FONT color="green">284</FONT>             * <a name="line.284"></a>
<FONT color="green">285</FONT>             * @author Benny Bottema<a name="line.285"></a>
<FONT color="green">286</FONT>             * @since 1.0<a name="line.286"></a>
<FONT color="green">287</FONT>             */<a name="line.287"></a>
<FONT color="green">288</FONT>            private class InputHandler implements Runnable {<a name="line.288"></a>
<FONT color="green">289</FONT>    <a name="line.289"></a>
<FONT color="green">290</FONT>                    private static final String ERROR_SOCKET_CLOSED = "socket closed";<a name="line.290"></a>
<FONT color="green">291</FONT>                    private static final String ERROR_RECV_FAILED = "Software caused connection abort: recv failed";<a name="line.291"></a>
<FONT color="green">292</FONT>                    private static final String ERROR_CONNECTION_RESET = "Connection reset";<a name="line.292"></a>
<FONT color="green">293</FONT>    <a name="line.293"></a>
<FONT color="green">294</FONT>                    /**<a name="line.294"></a>
<FONT color="green">295</FONT>                     * Thread method that waits for input on the client {@link Socket}. Keeps waiting for input while the server is running and no<a name="line.295"></a>
<FONT color="green">296</FONT>                     * PingPong timeout has occurred or the client has gone away.&lt;br /&gt;<a name="line.296"></a>
<FONT color="green">297</FONT>                     * &lt;br /&gt;<a name="line.297"></a>
<FONT color="green">298</FONT>                     * The input data is read per line, so messages need to end with a newline character '\n'. Since clients need to conform to the<a name="line.298"></a>
<FONT color="green">299</FONT>                     * common denominator, they are required to append a zero (0) byte '\0' as per Flash clients. This character is appended to the<a name="line.299"></a>
<FONT color="green">300</FONT>                     * newline '\n' character and needs to be discarded manually using a {@link BufferedReader#read()}.<a name="line.300"></a>
<FONT color="green">301</FONT>                     * <a name="line.301"></a>
<FONT color="green">302</FONT>                     * @see SwiftSocketServer#isRunning()<a name="line.302"></a>
<FONT color="green">303</FONT>                     * @see ClientHandler#checkPong()<a name="line.303"></a>
<FONT color="green">304</FONT>                     */<a name="line.304"></a>
<FONT color="green">305</FONT>                    @Override<a name="line.305"></a>
<FONT color="green">306</FONT>                    public void run() {<a name="line.306"></a>
<FONT color="green">307</FONT>                            while (server.isRunning() &amp;&amp; (!pingPongMode || checkPong()) &amp;&amp; !clientContext.isClientSaidByeBye()) {<a name="line.307"></a>
<FONT color="green">308</FONT>                                    try {<a name="line.308"></a>
<FONT color="green">309</FONT>                                            final String line = clientContext.getClientEndpoint().readLine();<a name="line.309"></a>
<FONT color="green">310</FONT>                                            if (server.isRunning()) {<a name="line.310"></a>
<FONT color="green">311</FONT>                                                    if (line != null) {<a name="line.311"></a>
<FONT color="green">312</FONT>                                                            clientContext.getClientEndpoint().read();<a name="line.312"></a>
<FONT color="green">313</FONT>                                                            handleMessage(clientContext, line);<a name="line.313"></a>
<FONT color="green">314</FONT>                                                    } else {<a name="line.314"></a>
<FONT color="green">315</FONT>                                                            // client closed its connection the hard way<a name="line.315"></a>
<FONT color="green">316</FONT>                                                            LOGGER.debug(String.format("client %s closed connection non-gracefully", clientContext.getClientInetAddress()));<a name="line.316"></a>
<FONT color="green">317</FONT>                                                            server.disposeOfClient(clientContext);<a name="line.317"></a>
<FONT color="green">318</FONT>                                                            break;<a name="line.318"></a>
<FONT color="green">319</FONT>                                                    }<a name="line.319"></a>
<FONT color="green">320</FONT>                                            }<a name="line.320"></a>
<FONT color="green">321</FONT>                                    } catch (final SocketException e) {<a name="line.321"></a>
<FONT color="green">322</FONT>                                            if (e.getMessage().equals(ERROR_SOCKET_CLOSED) || e.getMessage().equals(ERROR_RECV_FAILED)<a name="line.322"></a>
<FONT color="green">323</FONT>                                                            || e.getMessage().equals(ERROR_CONNECTION_RESET)) {<a name="line.323"></a>
<FONT color="green">324</FONT>                                                    if (e.getMessage().equals(ERROR_SOCKET_CLOSED)) {<a name="line.324"></a>
<FONT color="green">325</FONT>                                                            final String msg = "tried to read or write to closed socket (was client %s dropped due to PingPong time-out?)";<a name="line.325"></a>
<FONT color="green">326</FONT>                                                            LOGGER.error(String.format(msg, clientContext.getClientInetAddress()));<a name="line.326"></a>
<FONT color="green">327</FONT>                                                    } else {<a name="line.327"></a>
<FONT color="green">328</FONT>                                                            final String msg = "socket in error state [%s] for client %s";<a name="line.328"></a>
<FONT color="green">329</FONT>                                                            LOGGER.error(String.format(msg, e.getMessage(), clientContext.getClientInetAddress()));<a name="line.329"></a>
<FONT color="green">330</FONT>                                                    }<a name="line.330"></a>
<FONT color="green">331</FONT>                                                    // In case of a socket closed, the client was most likely dropped by the server due to PingPong time-out, which<a name="line.331"></a>
<FONT color="green">332</FONT>                                                    // means bye bye already is set. However, in case the client was dropped due to another reason, manually update the<a name="line.332"></a>
<FONT color="green">333</FONT>                                                    // client to avoid further escalation<a name="line.333"></a>
<FONT color="green">334</FONT>                                                    server.disposeOfClient(clientContext);<a name="line.334"></a>
<FONT color="green">335</FONT>                                                    break;<a name="line.335"></a>
<FONT color="green">336</FONT>                                            }<a name="line.336"></a>
<FONT color="green">337</FONT>                                            // we have no clue what exception was thrown, just log the error and retry<a name="line.337"></a>
<FONT color="green">338</FONT>                                            LOGGER.error(e.getMessage(), e);<a name="line.338"></a>
<FONT color="green">339</FONT>                                    } catch (final IOException e) {<a name="line.339"></a>
<FONT color="green">340</FONT>                                            // we have no clue what exception was thrown, just log the error and retry<a name="line.340"></a>
<FONT color="green">341</FONT>                                            LOGGER.error(e.getMessage(), e);<a name="line.341"></a>
<FONT color="green">342</FONT>                                    }<a name="line.342"></a>
<FONT color="green">343</FONT>    <a name="line.343"></a>
<FONT color="green">344</FONT>                                    ServerUtil.defaultSleep();<a name="line.344"></a>
<FONT color="green">345</FONT>                            }<a name="line.345"></a>
<FONT color="green">346</FONT>                    }<a name="line.346"></a>
<FONT color="green">347</FONT>    <a name="line.347"></a>
<FONT color="green">348</FONT>                    /**<a name="line.348"></a>
<FONT color="green">349</FONT>                     * Handles a single client message string. Creates a {@link ClientMessageToServer} and adds this to the server message queue unless<a name="line.349"></a>
<FONT color="green">350</FONT>                     * it is a server level message, such as a 'pong' notification, in which case the message is executed directly.<a name="line.350"></a>
<FONT color="green">351</FONT>                     * <a name="line.351"></a>
<FONT color="green">352</FONT>                     * @param clientContext The client that sent the message being interpreted.<a name="line.352"></a>
<FONT color="green">353</FONT>                     * @param datagramMessage The client message string, minus newline character '\n' or zero (0) byte '\0'.<a name="line.353"></a>
<FONT color="green">354</FONT>                     * @see #createDecodedExecutableMessage(ClientContext, String)<a name="line.354"></a>
<FONT color="green">355</FONT>                     * @see SwiftSocketServer#addClientMessage(ClientMessageToServer)<a name="line.355"></a>
<FONT color="green">356</FONT>                     */<a name="line.356"></a>
<FONT color="green">357</FONT>                    public void handleMessage(final ClientContext clientContext, final String datagramMessage) {<a name="line.357"></a>
<FONT color="green">358</FONT>                            final ClientMessageToServer&lt;?&gt; message = createDecodedExecutableMessage(clientContext, datagramMessage);<a name="line.358"></a>
<FONT color="green">359</FONT>                            determineLogger(message).debug(<a name="line.359"></a>
<FONT color="green">360</FONT>                                            String.format("receiving message from %s: %s", clientContext, message.getClass().getSimpleName()));<a name="line.360"></a>
<FONT color="green">361</FONT>                            if (message instanceof ClientMessageToServerPingPong) {<a name="line.361"></a>
<FONT color="green">362</FONT>                                    ((ClientMessageToServerPingPong) message).execute(ClientHandler.this);<a name="line.362"></a>
<FONT color="green">363</FONT>                            } else if (message instanceof ClientMessageToServerByeBye) {<a name="line.363"></a>
<FONT color="green">364</FONT>                                    ((ClientMessageToServerByeBye) message).execute(ClientHandler.this);<a name="line.364"></a>
<FONT color="green">365</FONT>                            } else {<a name="line.365"></a>
<FONT color="green">366</FONT>                                    server.addClientMessage(message);<a name="line.366"></a>
<FONT color="green">367</FONT>                            }<a name="line.367"></a>
<FONT color="green">368</FONT>                    }<a name="line.368"></a>
<FONT color="green">369</FONT>    <a name="line.369"></a>
<FONT color="green">370</FONT>                    /**<a name="line.370"></a>
<FONT color="green">371</FONT>                     * Parses the raw client message into a message id and message content. Passes both values to<a name="line.371"></a>
<FONT color="green">372</FONT>                     * {@link #createDecodedExecutableMessage(ClientContext, int, String)} and returns the result. The first three bytes of the raw<a name="line.372"></a>
<FONT color="green">373</FONT>                     * message denote the message code.<a name="line.373"></a>
<FONT color="green">374</FONT>                     * &lt;p&gt;<a name="line.374"></a>
<FONT color="green">375</FONT>                     * In case anything goes wrong, a {@link ClientMessageToServerInvalid} object is returned instead which generates some useful<a name="line.375"></a>
<FONT color="green">376</FONT>                     * message for logging purposes. The server user can choose to filter out unknown messages at its own discretion. If a<a name="line.376"></a>
<FONT color="green">377</FONT>                     * &lt;code&gt;ClientMessageToServerInvalid&lt;/code&gt; is executed however, it will throw a runtime exception with the original message.<a name="line.377"></a>
<FONT color="green">378</FONT>                     * <a name="line.378"></a>
<FONT color="green">379</FONT>                     * @param clientMessage The client input string that represents a single message.<a name="line.379"></a>
<FONT color="green">380</FONT>                     * @return {@link #createDecodedExecutableMessage(ClientContext, int, String)}<a name="line.380"></a>
<FONT color="green">381</FONT>                     * @see #createInvalidMessage(String, Exception, String)<a name="line.381"></a>
<FONT color="green">382</FONT>                     */<a name="line.382"></a>
<FONT color="green">383</FONT>                    protected ClientMessageToServer&lt;?&gt; createDecodedExecutableMessage(final ClientContext clientContext, final String clientMessage) {<a name="line.383"></a>
<FONT color="green">384</FONT>                            final int messageId;<a name="line.384"></a>
<FONT color="green">385</FONT>                            try {<a name="line.385"></a>
<FONT color="green">386</FONT>                                    messageId = Integer.parseInt(clientMessage.substring(0, MESSAGEID_LENGTH));<a name="line.386"></a>
<FONT color="green">387</FONT>                            } catch (final NumberFormatException e) {<a name="line.387"></a>
<FONT color="green">388</FONT>                                    return createInvalidMessage(clientMessage, e, "invalid message identifier");<a name="line.388"></a>
<FONT color="green">389</FONT>                            }<a name="line.389"></a>
<FONT color="green">390</FONT>                            final String messageContent = clientMessage.substring(MESSAGEID_LENGTH);<a name="line.390"></a>
<FONT color="green">391</FONT>                            return createDecodedExecutableMessage(clientContext, messageId, messageContent);<a name="line.391"></a>
<FONT color="green">392</FONT>                    }<a name="line.392"></a>
<FONT color="green">393</FONT>    <a name="line.393"></a>
<FONT color="green">394</FONT>                    /**<a name="line.394"></a>
<FONT color="green">395</FONT>                     * Creates a {@link ClientMessageToServer} instance based on the message id and message content.<a name="line.395"></a>
<FONT color="green">396</FONT>                     * <a name="line.396"></a>
<FONT color="green">397</FONT>                     * @param clientContext The client that sent the message, useful to be able to reply to.<a name="line.397"></a>
<FONT color="green">398</FONT>                     * @param messageId The identifier for the message type we need to instantiate.<a name="line.398"></a>
<FONT color="green">399</FONT>                     * @param messageContent The message content for the solved message type to decode.<a name="line.399"></a>
<FONT color="green">400</FONT>                     * @return A {@link ClientMessageToServer} with identified by &lt;code&gt;messageId&lt;/code&gt; decoded from &lt;code&gt;messageContent&lt;/code&gt;.<a name="line.400"></a>
<FONT color="green">401</FONT>                     * @see SwiftSocketServer#getClientMessageToServerType(int)<a name="line.401"></a>
<FONT color="green">402</FONT>                     * @see ClientMessageToServer#decode(String)<a name="line.402"></a>
<FONT color="green">403</FONT>                     */<a name="line.403"></a>
<FONT color="green">404</FONT>                    private final ClientMessageToServer&lt;?&gt; createDecodedExecutableMessage(final ClientContext clientContext, final int messageId,<a name="line.404"></a>
<FONT color="green">405</FONT>                                    final String messageContent) {<a name="line.405"></a>
<FONT color="green">406</FONT>                            final Class&lt;? extends ClientMessageToServer&lt;?&gt;&gt; messageType = server.getClientMessageToServerType(messageId);<a name="line.406"></a>
<FONT color="green">407</FONT>                            ClientMessageToServer&lt;?&gt; message;<a name="line.407"></a>
<FONT color="green">408</FONT>                            try {<a name="line.408"></a>
<FONT color="green">409</FONT>                                    message = messageType.getConstructor(ClientContext.class).newInstance(clientContext);<a name="line.409"></a>
<FONT color="green">410</FONT>                            } catch (final NoSuchMethodException e) {<a name="line.410"></a>
<FONT color="green">411</FONT>                                    final String errorMessage = "message type '%s' has no valid constructor";<a name="line.411"></a>
<FONT color="green">412</FONT>                                    return createInvalidMessage(messageContent, e, String.format(errorMessage, messageType.getSimpleName()));<a name="line.412"></a>
<FONT color="green">413</FONT>                            } catch (final IllegalAccessException e) {<a name="line.413"></a>
<FONT color="green">414</FONT>                                    return createInvalidMessage(messageContent, e, "constructor not visible for message");<a name="line.414"></a>
<FONT color="green">415</FONT>                            } catch (final InvocationTargetException e) {<a name="line.415"></a>
<FONT color="green">416</FONT>                                    return createInvalidMessage(messageContent, e, "error calling message constructor");<a name="line.416"></a>
<FONT color="green">417</FONT>                            } catch (final InstantiationException e) {<a name="line.417"></a>
<FONT color="green">418</FONT>                                    return createInvalidMessage(messageContent, e, "unable to construct message");<a name="line.418"></a>
<FONT color="green">419</FONT>                            }<a name="line.419"></a>
<FONT color="green">420</FONT>                            message.decode(messageContent);<a name="line.420"></a>
<FONT color="green">421</FONT>                            return message;<a name="line.421"></a>
<FONT color="green">422</FONT>                    }<a name="line.422"></a>
<FONT color="green">423</FONT>    <a name="line.423"></a>
<FONT color="green">424</FONT>                    /**<a name="line.424"></a>
<FONT color="green">425</FONT>                     * Generates a {@link ClientMessageToServerInvalid} object with the failure cause. When executed, this message throws a runtime<a name="line.425"></a>
<FONT color="green">426</FONT>                     * exception with the original exception.<a name="line.426"></a>
<FONT color="green">427</FONT>                     * <a name="line.427"></a>
<FONT color="green">428</FONT>                     * @param originalMessage The original message<a name="line.428"></a>
<FONT color="green">429</FONT>                     * @param failureCause The exception that occurred when the original messages was being converted into a<a name="line.429"></a>
<FONT color="green">430</FONT>                     *            {@link ClientMessageToServer}.<a name="line.430"></a>
<FONT color="green">431</FONT>                     * @param cause A fine grained exception description when the exception &lt;code&gt;failureCause&lt;/code&gt; occurred.<a name="line.431"></a>
<FONT color="green">432</FONT>                     * @return An instance of {@link ClientMessageToServerInvalid}.<a name="line.432"></a>
<FONT color="green">433</FONT>                     */<a name="line.433"></a>
<FONT color="green">434</FONT>                    private ClientMessageToServer&lt;?&gt; createInvalidMessage(final String originalMessage, final Exception failureCause, final String cause) {<a name="line.434"></a>
<FONT color="green">435</FONT>                            final ClientMessageToServerInvalid message = new ClientMessageToServerInvalid(clientContext, failureCause);<a name="line.435"></a>
<FONT color="green">436</FONT>                            message.decode(String.format("%s (original message: '%s')", cause, originalMessage));<a name="line.436"></a>
<FONT color="green">437</FONT>                            return message;<a name="line.437"></a>
<FONT color="green">438</FONT>                    }<a name="line.438"></a>
<FONT color="green">439</FONT>            }<a name="line.439"></a>
<FONT color="green">440</FONT>    }<a name="line.440"></a>




























































</PRE>
</BODY>
</HTML>
